Arroba Backend API (0.0.1)

Download OpenAPI specification:Download

コマンド

これがしたい コマンド
ログイン このコマンドで取得したAccessTokenAuthorizationsとして使用してください
XXXX make xxxx-user1
XXXX make xxxx-user2
XXXX make xxxx-user3

Bearer

Access token (JWT) for API

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: JWT

cookieAuth

Arroba FireStore Auth

Security Scheme Type: API Key
Header parameter name: X-Firebase-Uid

sampleUser

ユーザ情報取得

SAMPLEです - ユーザ情報取得

現時点でのユーザ情報を取得

Authorizations:
cookieAuth
path Parameters
id
required
integer <int64>

ユーザID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ユーザ削除

SAMPLEです ユーザ削除
登録されているユーザーを削除

Authorizations:
cookieAuth
path Parameters
id
required
integer <int64>

ユーザID

Responses

Response samples

Content type
application/json
{
  • "data": null
}

ユーザ更新

SAMPLEです ユーザ更新
ユーザ情報更新処理を行う。

Request Body schema: application/json
id
required
integer <int64> (userId)

ユーザID

type
required
integer <int64> (userType) [ 1 .. 2 ]
Enum: 1 2

ユーザ種別

  • 1:ゲスト
  • 2:登録ユーザ
tel
required
string (tel)

電話番号

mail
required
string or null (mail)

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "type": 1,
  • "tel": "08034772013",
  • "mail": "yns@tepo.co.jp"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ユーザ検索

SAMPLEです - ユーザ検索

指定したパラメーターでユーザ検索を行う

Authorizations:
cookieAuth
query Parameters
offset
any

オフセット(サンプル)

limit
any

ページリミット(サンプル)

userTel
any
Example: userTel=08034772013

電話番号(サンプル)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ユーザ登録

SAMPLEです ユーザ登録
ユーザ登録処理を行う。
利用シーン

  • ユーザーの新規登録
  • ゲストの臨時利用
Authorizations:
None
Request Body schema: application/json
id
required
integer <int64> (userId)

ユーザID

type
required
integer <int64> (userType) [ 1 .. 2 ]
Enum: 1 2

ユーザ種別

  • 1:ゲスト
  • 2:登録ユーザ
tel
required
string (tel)

電話番号

mail
required
string or null (mail)

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "type": 1,
  • "tel": "08034772013",
  • "mail": "yns@tepo.co.jp"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/masters/bank_accounts

取扱口座検索

取扱口座検索

指定したパラメーターで取扱口座検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target
string

取扱口座検索ソート対象カラム

  • number
  • depositWithdrawalCategory
  • accountName
  • bankName
  • branchName
sort_order
string
Example: sort_order=desc

ソート種別

  • desc
  • asc
keyword
string

取扱口座検索キーワード検索(下記に対して中間一致)

  • 口座名
  • 銀行名
  • 支店名

Responses

Response samples

Content type
application/json
{ }

/masters/staffs

スタッフ検索

スタッフ検索
指定したパラメーターでスタッフ検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target
any
Example: sort_target=staffnumber

ソート対象カラム

sort_order
string
Example: sort_order=desc

ソート種別

  • desc
  • asc
last_work_day_from
any
Example: last_work_day_from=2023-04-21

最終稼働日from

last_work_day_to
any
Example: last_work_day_to=2023-11-04

最終稼働日to

genders[]
any
Example: genders[]=male

性別

  • male:男性
  • female:女性
branches[]
any
Example: branches[]=9mX6j6xffKhHdd389W1I

支店コード

keyword
string

キーワード検索

Responses

Response samples

Content type
application/json
{ }

/masters/standard_rewards

標準報酬検索

標準報酬検索

標準報酬検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target[]
Array of strings
Example: sort_target[]=health_insurance_grade

ソート対象カラム
指定可能な項目は以下の項目になります

  • 等級(健保):health_insurance_grade
  • 等級(厚保):pension_insurance_grade
  • 標準報酬月額:standard_reward_monthly_amount
  • 報酬月額(以上):standard_reward_monthly_amount_or_more
  • 報酬月額(未満):standard_reward_monthly_amount_less_than
sort_order[]
Array of strings
Example: sort_order[]=asc

ソート種別

  • desc
  • asc

Responses

Response samples

Content type
application/json
{ }

/masters/departments

部門検索

部門検索
指定したパラメーターで部門検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target
string
Example: sort_target=department_no

ソート対象カラム

指定可能な項目は以下の項目

  • 部門NO:department_no
  • 部門名称:department_abbreviation
  • 部門名:department_name
  • 親部門:parent_department_name
  • 並び順:department_order

未設定の場合のデフォルト:department_no asc

sort_order
string
Example: sort_order=desc

ソート種別

  • desc
  • asc
keyword
string

キーワード検索

deleted
string

削除可否

  • false
  • true

Responses

Response samples

Content type
application/json
{ }

/masters/users

担当者検索

担当者検索
指定したパラメーターで担当者検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target
string
Example: sort_target=department_no

ソート対象カラム

指定可能な項目は以下の項目

  • 担当者NO:user_number
  • 担当者名:user_name
  • 担当者名カナ:user_name_kana
  • 所属部署名:department_name

未設定の場合のデフォルト : user_number asc

sort_order
string
Example: sort_order=desc

ソート種別

  • desc
  • asc
keyword
string

キーワード検索

department_id
integer
Example: department_id=1

部門ID

search_category
required
integer
Example: search_category=1

対象

  • 対象:1
  • 対象外:2
  • 全件:99

未設定の場合のデフォルト : 全件

deleted
string

削除可否

  • false
  • true

Responses

Response samples

Content type
application/json
{ }

/masters/customer_classifications

得意先区分

指定した得意先区分に対する
id・nameを全件取得

Authorizations:
cookieAuth
query Parameters
customer_classification
required
string
Example: customer_classification=12

得意先区分

指定可能な項目は以下の項目

  • 得意先区分1:11
  • 得意先区分2:12
  • 得意先区分3:13
  • 得意先区分4:14
  • 得意先区分5:15
type_master_category
required
integer [ 0 .. 12 ]
Example: type_master_category=1

インポート時はclassificationに対応した値

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

infra

ヘルスチェックエンドポイント

ALB Health-Check Endpoint.

Responses

/salary_ledgers/printing

給料台帳(印刷)検索

給料台帳(印刷)検索
指定したパラメーターで給料台帳(印刷)検索を行う

Authorizations:
cookieAuth
query Parameters
page
required
integer <int64>
Example: page=2

ページ番号

per_page
required
integer <int64>
Example: per_page=2

1ページあたり表示件数

sort_target[]
Array of strings
Example: sort_target[]=staff_number

ソート対象カラム
指定可能な項目は以下の項目になります

  • スタッフNO:staff_number
  • 部門:department_name
  • スタッフカナ:staff_name_kana
    • 抽出結果のスタッフ名での並び替えはこのstaff_name_kanaを使用します
sort_order[]
Array of strings
Example: sort_order[]=asc

ソート種別

  • desc
  • asc
salary_payment_date_from
required
any
Example: salary_payment_date_from=2023-04-21

給料支給日from

salary_payment_date_to
required
any
Example: salary_payment_date_to=2023-11-04

給料支給日to

staff_number_from
any
Example: staff_number_from=000001

スタッフNO from

staff_number_to
any
Example: staff_number_to=000002

スタッフNO to

payroll_group
any
Example: payroll_group=1

給与締グループ

payment_method
any
Example: payment_method=0

給与支給方法

tax_classification
any
Example: tax_classification=1

課税区分

fs_department_id
any
Example: fs_department_id=1

所属部門id

handling_account_no
any
Example: handling_account_no=0001

取扱口座NO

Responses

Response samples

Content type
application/json
{ }